This is where the options or predicate function will be parsed. This
aligns with how we're parsing options in other APIs.

This copies the parsing logic from the existing browserContext.waitFor
Event() into the new WaitForEventOptions type's parse method. It also
modifies it so that the data that is parsed is updated in the type and
during parsing it will return an error instead of panicking.

This commit refactors the code so that it works with the new
WaitForEventOptions type.

This now defaults to the browserContext's default timeout. This should
fix the confusion of mixing seconds and milliseconds when working with
the timeouts in this API.

NOTE though that there is a default timeout of 30 seconds now, whereas
in PW there is no timeout unless one is set explicitly in
browserContext using SetDefaultTimeout.

At the moment we only support working with the new page creation event
(i.e. "page" event) when waitForEvent is used. This commit helps
clarify this to users.

When working with waitForEvent we now notify the user if the timeout
was reached, or whether the context is closed (i.e. the test iteration
has ended).

Instead of panicking when an error occurs, this commit refactors
waitForEvent to return an error back to the mapping layer where it can
do what it needs with the error.

This new way of working allows us to test the code with integration
tests, and it still works as expected when we run the API through a
test script. Before it seemed overly complex to try to create a goja
object that required reflection.

It's valid for a user not to pass anything but the event. A change
needed to be made to allow for a nil predicate to allow for this.

When a return occurs from runWaitForEventHandler it needs to perform
the same steps for all returns out of the method. This refactors those
duplicate steps into a defer function.

waitForEvent is useless without it being promisified. This changes
that so that waitForEvent returns a promise, allowing the user to set
a waitForEvent and then call further APIs which will unblock the
waitForEvent when possible (only for new page creations and if the
predicate function is set and returns a truthy value).

This helps make things more maintainable and reduces the risk of typos
when working with the event types for waitForEvent.

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

This helps tidy up the code and keeps the happy path more left aligned.

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

This just helps make the line lengths of comments consistent.

This not only use a more concise naming convention it also adds '_' to
the names, which makes it easier to find tests if they fail.

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>

This will help avoid typo issues and make the code more maintainable.